////////////////////////////////////////////////////////////////////////////////
//  
//  Copyright (c) 2010 Gabriel Montagné Láscaris-Comneno and Alberto
//  Brealey-Guzmán.
//  
//  Permission is hereby granted, free of charge, to any person obtaining a
//  copy of this software and associated documentation files (the "Software"),
//  to deal in the Software without restriction, including without limitation
//  the rights to use, copy, modify, merge, publish, distribute, sublicense,
//  and/or sell copies of the Software, and to permit persons to whom the
//  Software is furnished to do so, subject to the following conditions:
//  
//  The above copyright notice and this permission notice shall be included in
//  all copies or substantial portions of the Software.
//  
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
//  THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
//  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
//  DEALINGS IN THE SOFTWARE.
//  
////////////////////////////////////////////////////////////////////////////////

package com.rojored.controls.controlBarClasses 
{

import flash.events.Event;

/**
 *  The ControlBarEvent class represents event objects that are specific to
 *  the ControlBarEvent control.
 */
public class ControlBarEvent extends Event
{

    //--------------------------------------------------------------------------
    //
    //  Class constants
    //
    //--------------------------------------------------------------------------

    /**
     *  Event type for "play" control bar gestures.
     */
    public static const PLAY:String = "play";

    /**
     *  Event type for "pause" control bar gestures.
     */
    public static const PAUSE:String = "pause";

    /**
     *  Event type for the "scrub" control bar gestures. 
     */
    public static const SCRUB:String = "scrub";

    /**
     *  Event type for "volume change" control bar gestures.
     */
    public static const VOLUME_CHANGE:String = "volumeChange";

    //--------------------------------------------------------------------------
    //
    //  Constructor
    //
    //--------------------------------------------------------------------------

    /**
     *  Constructor
     */
    public function ControlBarEvent(type:String, playheadTime:Number = NaN,
                                    volume:Number = NaN,
                                    bubbles:Boolean = false,
                                    cancelable:Boolean = false)

    {
        super(type, bubbles, cancelable);
        this.playheadTime = playheadTime;
        this.volume = volume;
    }

    //--------------------------------------------------------------------------
    //
    //  Properties 
    //
    //--------------------------------------------------------------------------

    //--------------------------------------
    //  playheadTime 
    //--------------------------------------

    /**
     *  Playhead position, measured in seconds, since the media starting
     *  playing. 
     */
    public var playheadTime:Number;

    //--------------------------------------
    //  volume 
    //--------------------------------------

    /**
     *  Audio volume, in a range of 0 to 1, of the media player.
     */
    public var volume:Number;

    //--------------------------------------------------------------------------
    //
    //  Overridden methods
    //
    //--------------------------------------------------------------------------

    /**
     *  @private
     */
    override public function clone():Event 
    {
        return new ControlBarEvent(type, playheadTime, volume, bubbles,
            cancelable);
    }

    /**
     *  @private
     */
    override public function toString():String 
    {
        return formatToString(
            "ControlBarEvent",
            "type",
            "playheadTime",
            "bubbles",
            "cancelable",
            "eventPhase"
        );
    }
}
}
